Add scripting for custom property types #3971

dogboydog · 2024-06-16T22:20:39Z

Aims to fix #3419

Related to #2902

Demo of the functionality so far in the console:

> for (let t of tiled.project.propertyTypes) { tiled.log( t.name) }
Breakable
Door
Enemy
KillZone
> tiled.project.findTypeByName('Enemy').name
$0 = Enemy
> tiled.project.findTypeByName('Enemy').color
$1 = #ff0000
> tiled.project.findTypeByName('Enemy').isClass
$2 = true 
> tiled.project.findTypeByName('Enemy').usageFlags  & ClassPropertyType.LayerClass
$2 = 0
> tiled.project.findTypeByName('Enemy').usageFlags  & ClassPropertyType.MapObjectClass
$3 = 4

TODO:

Editing properties on custom types
Adding new enum and class types to the project
Add validation to prevent duplicate named types from being added to the project
Adding new members to class types, including members that are classes
Removing members from a class type
Removing types from the project
Add scripting doc (@dogboydog will do this but once the API contract is finalized)

bjorn

It's a great start, @dogboydog! There are some open questions, especially what to do with the raw pointer and potentially whether we should rather return class members as an array (though that does seem a little clumsy and somewhat pointless since internally it's still a map for now).

src/tiled/scriptpropertytype.h

bjorn · 2024-06-18T13:59:20Z

src/tiled/scriptpropertytype.h

+
+    QColor color() const { return mClassType->color; }
+    // TODO: " No viable overloaded '=' "
+    // void setColor(QColor &value) { mClassType->color = value; }


I wonder if this is just cause of passing by reference. The argument should either be by value or by const-reference.

Neither of those compile right now.

void setColor(QColor value) { mClassType->color = value; }

C:\Users\chris\tiled\src\tiled\scriptpropertytype.h:116: error: C2678: binary '=': no operator found which takes a left-hand operand of type 'const QColor' (or there is no acceptable conversion) C:\Users\chris\tiled\src\tiled\scriptpropertytype.h(116): note: Conversion loses qualifiers

Or
void setColor(const QColor &value) { mClassType->color = value; }

C:\Users\chris\tiled\src\tiled\scriptpropertytype.h:116: error: C2678: binary '=': no operator found which takes a left-hand operand of type 'const QColor' (or there is no acceptable conversion) C:\Users\chris\tiled\src\tiled\scriptpropertytype.h(116): note: Conversion loses qualifiers

Ah, it's just because mClassType is a const ClassPropertyType*, so you can't modify it. You'd need a non-const ClassPropertyType*.

Now that we have QSharedPointer<ClassPropertyType> mClassType, we can assign a new color to mClassType->color. Just note that a UI update will need to be triggered as well and we also might want to save the project. These things currently happen only from PropertyTypesEditor::applyPropertyTypes, which is called from all the places where changes are made to the types.

I'm not sure about triggering saving of the project immediately though. It would be better to schedule this to avoid too much file writing in case of changing a bunch of things from a script.

I think we could start with just triggering emit Preferences::instance()->propertyTypesChanged() after applying changes.

src/tiled/scriptpropertytype.h

dogboydog · 2024-09-07T01:15:39Z

I rebased this from master and tried to take another look, but I still don't feel confident in how to proceed. PropertyTypes returns const pointers which I can't use to modify values nor to try to store a pointer back to the script type to manage cleaning up. Also, you mentioned that there may be a change in how property types are stored coming up, so that they aren't sorted by name and rather allow the user to re-order them, so if I were to try to change PropertyTypes now I'm not sure if that would conflict.

Sorry, I don't write much C++ and so I'm not used to dealing with pointers/const qualifiers

bjorn · 2024-09-10T06:46:58Z

@dogboydog That's alright, thank you for rebasing the PR!

I would say not to worry about introducing conflicts, since I'd anyway be around to help resolve them again. But yeah, I understand the ownership and const stuff can be a little much if you're not used to C++. I'll see if I can have another look this week.

dogboydog · 2025-01-22T23:35:31Z

src/tiled/scriptpropertytype.h

+    bool drawFill() const { return mClassType->drawFill; }
+    // void setDrawFill(bool value) { mClassType->drawFill = value; }
+    int usageFlags() const { return mClassType->usageFlags; }
+    //void setUsageFlags(int value) { mClassType->setUsageFlags(value); }


The setter for usage flags accepts bool value to either turn the specified flags on or off, but it doesn't in itself provide a way to just set the usage flags to the specified value. Would script writers expect to be able to just hard set the usage flags to a value (personally, this is what I think makes sense so that you can do things like &= , |= the flags) or have a method like setUsageFlags(flags, value: bool) ?

Without changing the setUsageFlags in propertytype.cpp, to achieve a setter, I could turn off all flags with setUsageFlags( ClassUsageFlag. AnyUsage , false) and then turn the specified flags on with setUsageFlags(flagsFromScriptUser, true) if that makes sense

Indeed that signature is quite UI-oriented since it's used in response to the user toggling checkboxes. I agree from a scripting API point of view, we probably just want to be able to set the flags directly and you could introduce a void ClassPropertyType::setUsageFlags(int flags) overload for this (though actually two calls, like you suggested, is also a fine solution).

src/tiled/editableproject.cpp

…ead-only propertie

…ws a type error

…ypes.all instead) and add getter for class property members. getting members of class types does not work though

…s a list of types and move the utility methods for custom types to tiled.project

;)

This way, the type is kept alive by the ScriptPropertyType, which avoids crashes when accessing roaming pointers. Also, since it now has a non-const reference we can make the properties writable.

…type from scripting

…low removing members from a class

dogboydog · 2025-03-06T23:01:22Z

Name duplication validation seems to be working

Added the ability to remove a class's member

Maybe putting the script error utility for duplicate names in project.h/project.cpp isn't that clean since the Project class isn't really related to scripting. But I wasn't sure how to get the current EditableProject instead

Like this it could be somewhat useful, since now the value is typed correctly.

With two overloads, one for raw integer values and one for PropertyValue, for convenience. The latter raises an error if it's not of the right type.

static_cast can be used to access the subclasses instead of storing more specifically typed shared pointers.

bjorn reviewed Jun 18, 2024

View reviewed changes

dogboydog force-pushed the 3419_scripting_custom_types branch from b1486e2 to e80e00b Compare September 7, 2024 00:47

dogboydog force-pushed the 3419_scripting_custom_types branch 2 times, most recently from 5729b4e to 0232264 Compare January 17, 2025 16:55

dogboydog commented Jan 22, 2025

View reviewed changes

dogboydog force-pushed the 3419_scripting_custom_types branch from d293bea to 4a697eb Compare January 24, 2025 01:54

bjorn reviewed Jan 26, 2025

View reviewed changes

src/tiled/editableproject.cpp Outdated Show resolved Hide resolved

dogboydog force-pushed the 3419_scripting_custom_types branch from b3f333e to f02a78f Compare January 28, 2025 22:40

dogboydog and others added 12 commits March 6, 2025 14:01

expose tiled.project.propertyTypes to scripting, starting with some r…

e6ec374

…ead-only propertie

rename findTypeByName to findByName, starting to add removal of types

cee8eeb

try adding iterator to tiled.project.propertyTypes. currently it thro…

687436b

…ws a type error

remove iterator from ScriptPropertyTypes (use tiled.project.propertyT…

6572561

…ypes.all instead) and add getter for class property members. getting members of class types does not work though

restructure the property types API to make tiled.project.propertyType…

ad9751f

…s a list of types and move the utility methods for custom types to tiled.project

add ClassPropertyType.ClassUsageFlag, classType.usageFlags to scripting

d5010bd

fix comments in propertytype.cpp

9a0e5a8

Minor code style changes

16d594e

Fixed removal of types by name

2b4d2f4

;)

Changed PropertyType instances to be managed by shared pointer

7f6b55e

This way, the type is kept alive by the ScriptPropertyType, which avoids crashes when accessing roaming pointers. Also, since it now has a non-const reference we can make the properties writable.

allow editing color, drawFill, usageFlags, enum values, enum storage …

99a1350

…type from scripting

support adding new enum and class types with tiled.project scripting

da70b69

bjorn force-pushed the 3419_scripting_custom_types branch from f02a78f to da70b69 Compare March 6, 2025 13:03

prevent duplicate names in property types during adding or rename. al…

024610a

…low removing members from a class

bjorn added 5 commits March 7, 2025 17:39

Code tweaks and addressed type question for addMember

4227b62

Fixed return value of PropertyType.defaultValue

53dd077

Like this it could be somewhat useful, since now the value is typed correctly.

More sensible location for throwDuplicateNameError

feba321

Tweaks and added EnumPropertyType.addValue

63e7c86

Added EnumPropertyType.nameOf

56380d0

With two overloads, one for raw integer values and one for PropertyValue, for convenience. The latter raises an error if it's not of the right type.

Use a single shared pointer to refer to the type

87e3076

static_cast can be used to access the subclasses instead of storing more specifically typed shared pointers.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add scripting for custom property types #3971

Add scripting for custom property types #3971

dogboydog commented Jun 16, 2024 •

edited by bjorn

Loading

bjorn left a comment

bjorn Jun 18, 2024

dogboydog Jun 18, 2024

bjorn Jun 19, 2024

bjorn Jan 22, 2025

dogboydog commented Sep 7, 2024

bjorn commented Sep 10, 2024

dogboydog Jan 22, 2025

bjorn Jan 23, 2025 •

edited

Loading

dogboydog commented Mar 6, 2025 •

edited

Loading

Add scripting for custom property types #3971

Are you sure you want to change the base?

Add scripting for custom property types #3971

Conversation

dogboydog commented Jun 16, 2024 • edited by bjorn Loading

bjorn left a comment

Choose a reason for hiding this comment

bjorn Jun 18, 2024

Choose a reason for hiding this comment

dogboydog Jun 18, 2024

Choose a reason for hiding this comment

bjorn Jun 19, 2024

Choose a reason for hiding this comment

bjorn Jan 22, 2025

Choose a reason for hiding this comment

dogboydog commented Sep 7, 2024

bjorn commented Sep 10, 2024

dogboydog Jan 22, 2025

Choose a reason for hiding this comment

bjorn Jan 23, 2025 • edited Loading

Choose a reason for hiding this comment

dogboydog commented Mar 6, 2025 • edited Loading

dogboydog commented Jun 16, 2024 •

edited by bjorn

Loading

bjorn Jan 23, 2025 •

edited

Loading

dogboydog commented Mar 6, 2025 •

edited

Loading